[RDY] Add man page for corsix-th #1446
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TheCycoONE
changed the title
TheCycoONE
changed the title
TheCycoONE
changed the title
TheCycoONE
changed the title
|
Need to exclude Apple |
CorsixTH/corsix-th.6
Outdated
| .Nd "An" open source implementation "of" Theme Hospital | ||
| .Sh SYNOPSIS | ||
| .Nm | ||
| .Op Fl -bitmap-dir Ns Ar =path |
There was a problem hiding this comment.
Is it intentional that the = is concatenated with path here? other options do it differently, not to mention line 44
| .Sh DESCRIPTION | ||
| CorsixTH is a reimplementation of the 1997 Bullfrog business simulation game Theme Hospital. | ||
| As well as faithfully recreating the original, CorsixTH adds support for modern operating systems, high resolution displays, and much more. | ||
| A purchased copy of Theme Hospital, or the Theme Hospital demo is required to use CorsixTH. |
There was a problem hiding this comment.
Isn't the demo useful for only a few levels? It now looks asif it's a full alternative for the purchased copy.
Would be fair to warn about that, I think.
There was a problem hiding this comment.
I copied this text, with minor editing, from http://corsixth.com/
CorsixTH/corsix-th.6
Outdated
| Screenshot directory. | ||
| .El | ||
| .Sh COPYRIGHT | ||
| .Lk https://raw.githubusercontent.com/CorsixTH/CorsixTH/master/LICENSE.txt |
There was a problem hiding this comment.
Maybe mention the name of the license as well, for those without Internet while reading the man page?
|
Just minor stuff, looking great, nice job |
|
Updated to hopefully address your concerns and mine. |
New man page inspired by the one included in Debian. Add man page to unix install
TheCycoONE
changed the title
|
Ready to merge |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New man page inspired by the one included in Debian. This one is written in mdoc; which has the advantage of being a largely semantic markup producing consistent man pages.
I plan to sort the resource files dumped into /CorsixTH in the future; at present this seems like it belongs; which allows me to put it in the CorsixTH CMake file, and likewise add a man page for e.g. AnimView that is only installed when AnimView is included in the build.
I do plan to add the install to cmake as part of this PR. I will likely also add a files section similar to what Debian has.